home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 176-200 / disk_197 / ctags / ctags.cat < prev    next >
Text File  |  1992-05-06  |  4KB  |  129 lines
  1.  
  2.  
  3.  
  4.  
  5. CTAGS(1)                   User Commands                  CTAGS(1)
  6.  
  7.  
  8.  
  9. NNAAMMEE
  10.      ctags - create a tags file
  11.  
  12. SSYYNNOOPPSSIISS
  13.      ccttaaggss [ --BBFFaattuuwwvvxx ] name ...
  14.  
  15. DDEESSCCRRIIPPTTIIOONN
  16.      _C_t_a_g_s makes a tags file for _e_x(1) from the specified C, Pas-
  17.      cal, Fortran, YACC, lex, and lisp sources.  A tags file
  18.      gives the locations of specified objects (in this case func-
  19.      tions and typedefs) in a group of files.  Each line of the
  20.      tags file contains the object name, the file in which it is
  21.      defined, and an address specification for the object defini-
  22.      tion. Functions are searched with a pattern, typedefs with a
  23.      line number. Specifiers are given in separate fields on the
  24.      line, separated by blanks or tabs.  Using the _t_a_g_s file, _e_x
  25.      can quickly find these objects definitions.
  26.  
  27.      If the --xx flag is given, _c_t_a_g_s produces a list of object
  28.      names, the line number and file name on which each is
  29.      defined, as well as the text of that line and prints this on
  30.      the standard output.  This is a simple index which can be
  31.      printed out as an off-line readable function index.
  32.  
  33.      If the --vv flag is given, an index of the form expected by
  34.      _v_g_r_i_n_d(1) is produced on the standard output.  This listing
  35.      contains the function name, file name, and page number
  36.      (assuming 64 line pages).  Since the output will be sorted
  37.      into lexicographic order, it may be desired to run the out-
  38.      put through ssoorrtt --ff.  Sample use:
  39.           ctags -v files | sort -f > index
  40.           vgrind -x index
  41.  
  42.      Files whose names end in ..cc or ..hh are assumed to be C source
  43.      files and are searched for C routine and macro definitions.
  44.      Files whose names end in ..yy are assumed to be YACC source
  45.      files.  Files whose names end in ..ll are assumed to be either
  46.      lisp files if their first non-blank character is `;', `(',
  47.      or `[', or lex files otherwise.  Other files are first exam-
  48.      ined to see if they contain any Pascal or Fortran routine
  49.      definitions; if not, they are processed again looking for C
  50.      definitions.
  51.  
  52.      Other options are:
  53.  
  54.      --FF use forward searching patterns (/.../) (default).
  55.  
  56.      --BB use backward searching patterns (?...?).
  57.  
  58.      --aa append to tags file.
  59.  
  60.  
  61.  
  62.  
  63.  
  64. Formatted 88/12/30        25 August 1982                        1
  65.  
  66.  
  67.  
  68.  
  69. CTAGS(1)                   User Commands                  CTAGS(1)
  70.  
  71.  
  72.  
  73.      --tt create tags for typedefs.
  74.  
  75.      --ww suppressing warning diagnostics.
  76.  
  77.      --uu causing the specified files to be _u_p_d_a_t_e_d in tags, that
  78.         is, all references to them are deleted, and the new
  79.         values are appended to the file.  (Beware: this option is
  80.         implemented in a way which is rather slow; it is usually
  81.         faster to simply rebuild the _t_a_g_s file.)
  82.  
  83.      The tag _m_a_i_n is treated specially in C programs.  The tag
  84.      formed is created by prepending _M to the name of the file,
  85.      with a trailing .c removed, if any, and leading pathname
  86.      components also removed.  This makes use of _c_t_a_g_s practical
  87.      in directories with more than one program.
  88.  
  89. FFIILLEESS
  90.      tags      output tags file
  91.  
  92. SSEEEE AALLSSOO
  93.      ex(1), vi(1)
  94.  
  95. AAUUTTHHOORR
  96.      Ken Arnold; FORTRAN added by Jim Kleckner; Bill Joy added
  97.      Pascal and --xx,, replacing _c_x_r_e_f_; C typedefs added by Ed
  98.      Pelegri-Llopart.
  99.  
  100. BBUUGGSS
  101.      Recognition of ffuunnccttiioonnss, ssuubbrroouuttiinneess and pprroocceedduurreess for
  102.      FORTRAN and Pascal is done is a very simpleminded way.  No
  103.      attempt is made to deal with block structure; if you have
  104.      two Pascal procedures in different blocks with the same name
  105.      you lose.
  106.  
  107.      The method of deciding whether to look for C or Pascal and
  108.      FORTRAN functions is a hack.
  109.  
  110.      Does not know about #ifdefs.
  111.  
  112.      Should know about Pascal types.  Relies on the input being
  113.      well formed to detect typedefs.  Use of -tx shows only the
  114.      last line of typedefs.
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128. Formatted 88/12/30        25 August 1982                        2
  129.